[FIP-37] Add bitmap infrastructure: BitmapUtils, RoaringBitmapSerializer, AbstractRbAggFunction#3319
Open
Prajwal-banakar wants to merge 3 commits into
Open
[FIP-37] Add bitmap infrastructure: BitmapUtils, RoaringBitmapSerializer, AbstractRbAggFunction#3319Prajwal-banakar wants to merge 3 commits into
Prajwal-banakar wants to merge 3 commits into
Conversation
Contributor
Author
|
Hi @polyzos @wuchong @platinumhamburg could you please help review here? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Linked issue: Part of #3289
This PR adds the foundational infrastructure for FIP-37 RoaringBitmap SQL function implementation. It provides the serialization utilities, custom Flink type serializer, and base aggregate function class that will be used by the bitmap SQL functions (
rb_build_agg,rb_or_agg,rb_and_agg, etc.) in subsequent PRs.Brief change log
Added the following infrastructure files in
fluss-flink/fluss-flink-common:RoaringBitmapusing the ByteBuffer-based approach, which matches the server-sideRoaringBitmapUtils.serializeRoaringBitmap32format used byFieldRoaringBitmap32Aggfor wire compatibility.TypeSerializerforRoaringBitmapaccumulators to ensure correct checkpoint/savepoint behavior. Without this, Flink falls back to Kryo which is sensitive to internal class layout changes across RoaringBitmap library versions.TypeInformationwrapper that provides the custom serializer to Flink's type system.@FunctionHint(accumulator = @DataTypeHint(value = "RAW", bridgedTo = RoaringBitmap.class))annotation. This tells Flink's Table planner to skip reflection-based POJO field extraction on RoaringBitmap and use the customTypeInformationinstead.RoaringBitmapSerializerandRoaringBitmapTypeInfobehavior, including serialization round-trip, copy methods, snapshot configuration, and type information checks.AbstractRbAggFunction, since it is abstract and cannot be directly covered by unit tests.RoaringBitmapdependency (version 1.3.0 from root pom).The aggregate functions (
rb_build_agg,rb_or_agg,rb_and_agg) and catalog registration will follow in subsequent PRs linked to this issue.Tests
Unit tests added and passing:
BitmapUtilsTest.testNullInputToBytes()- null handling.BitmapUtilsTest.testNullInputFromBytes()- null handling.BitmapUtilsTest.testEmptyBitmapRoundTrip()- empty bitmap serialization.BitmapUtilsTest.testKnownValuesRoundTrip()- correctness with known values.BitmapUtilsTest.testLargeCardinality()- performance with 100K elements.BitmapUtilsTest.testFormatCompatibleWithServerSerialization()- wire compatibility.Tests are still running and this PR description will be updated with the final verification results once the full validation completes.
Verified with:
./mvnw spotless:apply -pl fluss-flink/fluss-flink-common- BUILD SUCCESS../mvnw test -pl fluss-flink/fluss-flink-common -Dtest=BitmapUtilsTest- BUILD SUCCESS../mvnw clean install -pl fluss-flink/fluss-flink-common -DskipTests- BUILD SUCCESS../mvnw clean package -DskipTests(full project build) - BUILD SUCCESS.API and Format
This change does not affect any public API or storage format. It adds internal infrastructure utilities that will be used by future bitmap SQL functions.
Documentation
This change does not introduce new user-facing features yet. The bitmap SQL functions (
rb_build_agg,rb_or_agg,rb_and_agg) and their documentation will be added in follow-up PRs.